¶ Relatórios do Sistema

O Syn Privado permite a execução de todos os relatórios nativos e personalizados do sistema, sejam eles visualizados ou impressos.

¶ Requisitos para Execução de Relatórios

Nome Interno do Relatório (_AActionName): Identificador interno da rotina.
Parâmetros do Relatório: Caso o relatório exija parâmetros obrigatórios.

Com essas informações, é possível executar qualquer relatório de forma eficiente.

¶ Endpoint para Executar processos

O Endpoint utilizado para a execução de processos é: GET - Api/TnWebDMRelatorio/Executar.

Parâmetros Necessários:
_AActionName: Nome interno do relatório.
_ABase64: Define se o retorno deve estar em Base64. Deve ser informado True ou False.
_ATipoRetorno: Especifica o formato de saída, como PDF, JPEG, NHZ, entre outros.

Para o parâmetro _ATipoRetorno deve ser informado os seguintes valores:


Valor	Descrição
nrwexRtf	Exportação em formato Rtf.
nrwexHtml	Exportação em formato HTML.
nrwexTxt	Exportação em formato TXT.
nrwexCSV	Exportação em formato CSV.
nrwexJpeg	Exportação em formato JPEG.
nrwexPDF	Exportação em formato PDF.
nrwexNHZ	Exportação em formato NHZ.

⚠️ Atenção: Quando o parâmetro _ATipoRetorno é configurado como PDF, JPEG ou NHZ, o _ABase64 deve ser definido como true.

Além dos parâmetros listados, caso o relatório possua parâmetros obrigatórios, é necessário incluir um Body na requisição.

Observações

O funcionamento correto de alguns formatos de saída pode variar conforme o relatório selecionado.
Os parâmetros do Body devem ser ajustados de acordo com o relatório e o formato de retorno desejado.

¶ Exemplo de Requisição

Como exemplo usaremos o relatório de Impressoras Fiscais. O Body das requisições será o mesmo, porém os parâmetros irão mudar conforme o formato de retorno desejado.

URL: http://localhost:8080/api/TnWebDMRelatorio/Executar_AActionName=nFisRRImpressoraFiscal&_ABase64=False&_ATipoRetorno=nrwexTXT

¶ Body da Requisição

¶ Respostas Esperadas

Formato TXT:

Formato CSV:

Formato HTML:

Formato RTF:

Formato JPEG

Observação: Neste exemplo o relatório citado não possui nenhuma imagem.

Formato NHZ

⚠️ Atenção: Conforme mencionado, alguns formatos não irão funcionar corretamente dependendo do relatório.

Formato PDF:

Observação: Alguns formatos podem apresentar limitações específicas para determinados relatórios.

¶ Validação de Respostas

A resposta ao executar um relatório via API deve ser equivalente à obtida ao realizar o mesmo processo manualmente no sistema.

Se a requisição retornar um status 200 mas o resultado indicar um erro, revise os parâmetros enviados no Body para garantir que estão corretos.

Este artigo foi útil?

Avaliação registrada com sucesso.

Não foi possível registrar a avaliação.